home *** CD-ROM | disk | FTP | other *** search
/ Linux Cubed Series 3: Developer Tools / Linux Cubed Series 3 - Developer Tools.iso / devel / lang / lisp / guile-ii.src / guile-ii / guile-src / slib / README < prev    next >
Encoding:
Text File  |  1995-02-28  |  9.8 KB  |  215 lines
  1. This directory contains the distribution of Scheme Library slib2a2.
  2. Slib conforms to Revised^4 Report on the Algorithmic Language Scheme
  3. and the IEEE P1178 specification.  Slib supports Unix and similar
  4. systems, VMS, and MS-DOS.
  5.  
  6. The maintainer can be reached at jaffer@ai.mit.edu or
  7. Aubrey Jaffer, 84 Pleasant St., Wakefield MA 01880-1846.
  8.  
  9.                    MANIFEST
  10.  
  11.   `README' is this file.  It contains a MANIFEST, INSTALLATION
  12.     INSTRUCTIONS, and proposed coding standards.
  13.   `FAQ' Frequently Asked Questions and answers.
  14.   `ChangeLog' documents changes to slib.
  15.   `slib.texi' has documentation on library packages in TexInfo format.
  16.  
  17.   `Template.scm' Example configuration file.  Copy and customize to
  18.     reflect your system.
  19.   `chez.init' is a configuration file for Chez Scheme.
  20.   `elk.init' is a configuration file for ELK 2.1
  21.   `gambit.init' is a configuration file for Gambit Scheme.
  22.   `macscheme.init' is a configuration file for MacScheme.
  23.   `mitscheme.init' is a configuration file for MIT Scheme.
  24.   `mitcomp.pat' is a patch file which adds definitions to SLIB files
  25.     for the MitScheme compiler.
  26.   `scheme2c.init' is a configuration file for DEC's scheme->c.
  27.   `scheme48.init' is a configuration file for Scheme48.
  28.   `t3.init' is a configuration file for T3.1 in Scheme mode.
  29.   `vscm.init' is a configuration file for VSCM.
  30.   `require.scm' has code which allows system independent access to
  31.     the library files.
  32.  
  33.   `format.scm' has Common-Lisp style format.
  34.   `formatst.scm' has code to test format.scm
  35.   `pp.scm' has pretty-print.
  36.   `ppfile.scm' has pprint-file and pprint-filter-file.
  37.   `obj2str.scm' has object->string.
  38.   `strcase.scm' has functions for manipulating the case of strings.
  39.   `genwrite.scm' has a generic-write which is used by pp.scm,
  40.     pp2str.scm and obj2str.scm
  41.   `stdio.scm' has printf, fprintf, and sprintf compatible with C.
  42.   `scanf.scm' has scanf, fscanf, and sscanf inspired by C.
  43.   `lineio' has line oriented input/output functions.
  44.   `debug.scm' has qp, a printer safe for circular structures and break
  45.     and continue.
  46.   `trace.scm' has trace and untrace for tracing function execution.
  47.   `test.scm' has routines useful for testing and reporting problems.
  48.   `strport.scm' has routines for string-ports.
  49.  
  50.   `alist.scm' has functions accessing and modifying association lists.
  51.   `hash.scm' defines hash, hashq, and hashv.
  52.   `hashtab.scm' has hash tables.
  53.   `sierpinski.scm' 2-dimensional coordinate hash.
  54.   `soundex.scm' English name hash.
  55.   `logical.scm' emulates 2's complement logical operations.
  56.   `random.scm' has random number generator compatible with Common Lisp.
  57.   `randinex.scm' has inexact real number distributions.
  58.   `prime.scm' has prime? and factor.
  59.   `charplot.scm' has procedure for plotting on character screens.
  60.   `plottest.scm' has code to test charplot.scm.
  61.   `tek40.scm' has routines for Tektronix 4000 series graphics.
  62.   `tek41.scm' has routines for Tektronix 4100 series graphics.
  63.   `getopt.scm' has posix-like getopt for parsing command line arguments. 
  64.   `time.scm' has Posix time conversion routines.
  65.   `cltime.scm' has Common-Lisp time conversion routines.
  66.   `comparse.scm' has shell-like command parsing.
  67.  
  68.   `rdms.scm' has code to construct a relational database from a base
  69.     table implementation.
  70.   `alistab.scm' has association list base tables.
  71.   `dbutil.scm' has utilities for creating and manipulating relational
  72.     databases.
  73.   `paramlst.scm' has procedures for passing parameters by name.
  74.   `report.scm' prints database reports.
  75.  
  76.   `record.scm' a MITScheme user-definable datatypes package
  77.   `promise.scm' has code from R4RS for supporting DELAY and FORCE.
  78.  
  79.   `repl.scm' has a read-eval-print-loop.
  80.   `defmacex.scm' has defmacro:expand*.
  81.   `mbe.scm' has "Macro by Example" define-syntax.
  82.   `scmacro.scm' is a syntactic closure R4RS macro package.
  83.     r4rsyn.scm, synclo.scm, synrul.scm have syntax definitions
  84.     and support.
  85.   `scmactst.scm' is code for testing SYNTACTIC CLOSURE macros.
  86.   `scainit.scm' is a syntax-case R4RS macro package.
  87.     scaglob.scm scamacr.scm scaoutp.scm scaexpp.scm have
  88.     syntax definitions and support.  `syncase.sh' is a shell
  89.     script for producing the SLIB version from the original.
  90.   `macwork.scm' is a "Macros that work" package.
  91.     mwexpand.scm mwdenote.scm mwsynrul.scm have support.
  92.     mwtest.scm is tests for Macros that work.
  93.   `macrotst.scm' is code from R4RS for testing macros.
  94.  
  95.   `values.scm' is multiple values.
  96.   `queue.scm' has queues and stacks.
  97.  
  98.   `object.scm' is object oriented programming (using no macros).
  99.   `recobj.scm' is records implemented using object.scm.
  100.   `yasyn.scm' is a macro package implementing YASOS using object.scm.
  101.  
  102.   `yasos.scm' is object oriented programming (using R4RS macros).
  103.   `collect.scm' is collection operators (like CL sequences).
  104.   `priorque.scm' has code and documentation for priority queues.
  105.   `rbtree.scm' has red-black trees.
  106.   `rbtest.scm' tests red-black trees.
  107.   `process.scm' has multi-processing primitives.
  108.   `array.scm' has multi-dimensional arrays and sub-arrays.
  109.   `arraymap.scm' has array-map!, array-for-each, and array-indexes.
  110.  
  111.   `sort.scm' has sorted?, sort, sort!, merge, and merge!
  112.   `comlist.scm' has many common list and mapping procedures.
  113.   `tree.scm' has functions dealing with trees.
  114.   `chap.scm' has functions which compare and create strings in
  115.     "chapter order".
  116.  
  117.   `sc4opt.scm' has optional rev4 procedures.
  118.   `sc4sc3.scm' has procedures to make a rev3 implementation run rev4
  119.     code. 
  120.   `sc2.scm' has rev2 procedures eliminated in subsequent versions.
  121.   `mularg.scm' redefines - and / to take more than 2 arguments.
  122.   `mulapply.scm' redefines apply to take more than 2 arguments.
  123.   `ratize.scm' has function rationalize from Revised^4 spec.
  124.   `trnscrpt.scm' has transcript-on and transcript-off from Revised^4 spec.
  125.   `withfile.scm' has with-input-from-file and with-output-to-file from R4RS.
  126.   `dynwind.scm' has proposed dynamic-wind from R5RS.
  127.   `dwindtst.scm' has routines for characterizing dynamic-wind.
  128.   `dynamic.scm' has proposed DYNAMIC data type.
  129.   `fluidlet.scm' has fluid-let syntax.
  130.   `struct.scm' has defmacros which implement RECORDS from the book:
  131.     "Essentials of Programming Languages".
  132.   `structure.scm' has syntax-case macros for the same.
  133.   `structst.scm' has test code for struct.scm and structure.scm.
  134.  
  135.               INSTALLATION INSTRUCTIONS
  136.  
  137.   Check the manifest in `README' to find a configuration file for your
  138. Scheme implementation.  Initialization files for most IEEE P1178
  139. compliant Scheme Implementations are included with this distribution.
  140.  
  141.   If the Scheme implementation supports `getenv', then the value of the
  142. shell environment variable SCHEME_LIBRARY_PATH will be used for
  143. `(library-vicinity)' if it is defined.  Currently, Chez, Elk,
  144. MITScheme, scheme->c, VSCM, and SCM support `getenv'.
  145.  
  146.   You should check the definitions of `software-type',
  147. `scheme-implementation-version', `implementation-vicinity', and
  148. `library-vicinity' in the initialization file.  There are comments in
  149. the file for how to configure it.
  150.  
  151.   Once this is done you can modify the startup file for your Scheme
  152. implementation to `load' this initialization file.  SLIB is then
  153. installed.
  154.  
  155.   Multiple implementations of Scheme can all use the same SLIB
  156. directory. Simply configure each implementation's initialization file
  157. as outlined above.
  158.  
  159.   The SCM implementation does not require any initialization file as
  160. SLIB support is already built in to SCM.  See the documentation with
  161. SCM for installation instructions.
  162.  
  163.   SLIB includes methods to create heap images for the VSCM and Scheme48
  164. implementations.  The instructions for creating a VSCM image are in
  165. comments in `vscm.init'.  To make a Scheme48 image, `cd' to the SLIB
  166. directory and type `make slib48'.  This will also create a shell script
  167. with the name `slib48' which will invoke the saved image.
  168.  
  169.              PORTING INSTRUCTIONS
  170.  
  171.   If there is no initialization file for your Scheme implementation, you
  172. will have to create one.  Your Scheme implementation must be largely
  173. compliant with `IEEE Std 1178-1990' or `Revised^4 Report on the
  174. Algorithmic Language Scheme' to support SLIB.
  175.  
  176.   `Template.scm' is an example configuration file.  The comments inside
  177. will direct you on how to customize it to reflect your system. Give
  178. your new initialization file the implementation's name with `.init'
  179. appended.  For instance, if you were porting `foo-scheme' then the
  180. initialization file might be called `foo.init'.
  181.  
  182.   Your customized version should then be loaded as part of your scheme
  183. implementation's initialization.  It will load `require.scm' from the
  184. library; this will allow the use of `provide', `provided?', and
  185. `require' along with the "vicinity" functions.  The rest of the
  186. library will then be accessible in a system independent fashion.
  187.  
  188.   Please mail new working configuration files to `jaffer@ai.mit.edu' so
  189. that they can be included in the SLIB distribution.
  190.  
  191.                CODING STANDARDS
  192.  
  193.   All library packages are written in IEEE P1178 Scheme and assume that
  194. a configuration file and `require.scm' package have already been
  195. loaded.  Other versions of Scheme can be supported in library packages
  196. as well by using, for example, `(provided? 'rev3-report)' or `(require
  197. 'rev3-report)'.
  198.  
  199.   `require.scm' defines `*catalog*', an association list of module
  200. names and filenames.  When a new package is added to the library, an
  201. entry should be added to `require.scm'.  Local packages can also be
  202. added to `*catalog*' and even shadow entries already in the table.
  203.  
  204.   The module name and `:' should prefix each symbol defined in the
  205. package.  Definitions for external use should then be exported by having
  206. `(define foo module-name:foo)'.
  207.  
  208.   Submitted packages should not duplicate routines which are already in
  209. SLIB files.  Use `require' to force those features to be supported in
  210. your package.  Care should be taken that there are no circularities in
  211. the `require's and `load's between the library packages.
  212.  
  213.   Documentation should be provided in Emacs Texinfo format if possible,
  214. But documentation must be provided.
  215.